Add SharedInformer implementation to python-client by Copilot · Pull Request #2515 · kubernetes-client/python

Copilot · 2026-02-20T18:34:38Z

Python clients wanting a local cache of Kubernetes resources had to implement their own watch loops, reconnection logic, and thread management. This adds a SharedInformer analogous to the Java and JavaScript client implementations.

New package: `kubernetes.informer`

ObjectCache (cache.py) — thread-safe in-memory store keyed by namespace/name; exposes list(), get(), get_by_key(), list_keys()
SharedInformer (informer.py) — daemon thread running list-then-watch loop with:
- Automatic reconnect on ApiException or other errors
- Event handler callbacks for ADDED, MODIFIED, DELETED, BOOKMARK, and ERROR
- resourceVersion tracking: reused on reconnect; reset on 410 Gone for a fresh re-list
- Periodic resync: fires a full list_func call every resync_period seconds even when the cluster is quiet (via timeout_seconds on the watch); resync fires ADDED/MODIFIED/DELETED by diffing old vs new state
- Namespace, label selector, and field selector pass-through

Testing

38 unit tests in kubernetes/test/test_informer.py, covering cache behaviour, event handlers, watch loop, BOOKMARK handling, resourceVersion tracking, 410 Gone recovery, periodic resync, and scenarios analogous to the JavaScript, Java, and client-go reference tests
6 end-to-end tests in kubernetes/e2e_test/test_informer.py (auto-skipped when no cluster is available):
- Pre-existing objects appearing in the cache after start()
- ADDED event firing and cache population when a ConfigMap is created
- MODIFIED event firing and updated data verified when a ConfigMap is patched
- DELETED event firing and cache removal when a ConfigMap is deleted
- resourceVersion advancing after real watch events are received
- Periodic resync firing MODIFIED for existing cached objects (test_resync_fires_modified_for_existing_objects)

Add `SharedInformer` to `kubernetes.informer`: a background thread that maintains a thread-safe local cache of Kubernetes objects by running a list-then-watch loop. Fires registered callbacks for ADDED/MODIFIED/DELETED/BOOKMARK/ERROR events, handles reconnects (with 410-Gone re-list), and supports periodic resync. Analogous to the Java and JavaScript client informer implementations.

💬 Send tasks to Copilot coding agent from Slack and Teams to turn conversations into code. Copilot posts an update in your thread when it's finished.

…example Co-authored-by: brendandburns <5751682+brendandburns@users.noreply.github.com>

k8s-ci-robot · 2026-02-20T18:41:47Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Copilot
Once this PR has been reviewed and has the lgtm label, please assign yliaog for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

brendandburns · 2026-02-20T18:50:34Z

@copilot can you add support for BOOKMARK events?

Co-authored-by: brendandburns <5751682+brendandburns@users.noreply.github.com>

Copilot · 2026-02-20T18:52:57Z

@copilot can you add support for BOOKMARK events?

Done in 9c708ad. Added a BOOKMARK constant and registered it in the handlers dict so consumers can call add_event_handler(BOOKMARK, fn). When a BOOKMARK event arrives in the watch stream the informer fires the handler with the raw BOOKMARK object (which carries the updated resourceVersion). The cache is not modified — BOOKMARK events carry no object state change. Two new tests cover this: one verifies the handler is called with the bookmark object, the other confirms the cache is unaffected.

brendandburns · 2026-02-20T18:56:02Z

@copilot can you implement it so that the most recent resourceVersion is stored and used for the re-list operation?

… on 410 Gone Co-authored-by: brendandburns <5751682+brendandburns@users.noreply.github.com>

Copilot · 2026-02-20T18:59:14Z

@copilot can you implement it so that the most recent resourceVersion is stored and used for the re-list operation?

Done in d21aa1b. SharedInformer now tracks _resource_version internally. After the initial list the RV is stored, and after each watch stream ends the Watch's latest RV (updated by every event including BOOKMARKs) is captured in finally. On reconnect the stored RV is passed directly to the next watch call — no full re-list is performed. The only exception is a 410 Gone response, which resets _resource_version to None so the next loop iteration triggers a fresh re-list. Three new tests cover: RV stored from Watch, reconnect skips re-list when RV is known, and 410 triggers re-list.

brendandburns · 2026-02-21T02:36:26Z

@copilot can you add end-to-end tests against a real cluster

Co-authored-by: brendandburns <5751682+brendandburns@users.noreply.github.com>

Copilot · 2026-02-21T02:39:22Z

@copilot can you add end-to-end tests against a real cluster

Done in 63bd3d5. Added kubernetes/e2e_test/test_informer.py with five tests that run against a real cluster (skipped automatically via base.get_e2e_configuration() when no cluster is reachable):

test_cache_populated_after_start — pre-existing ConfigMaps appear in the cache after start()
test_added_event_and_cache_entry — creating a ConfigMap fires ADDED and the object appears in the cache
test_modified_event_and_cache_refresh — patching a ConfigMap fires MODIFIED
test_deleted_event_removes_from_cache — deleting a ConfigMap fires DELETED and removes the object from the cache
test_resource_version_advances — the stored resourceVersion advances after receiving watch events

Each test uses a unique name (UUID suffix) and registers addCleanup to delete created ConfigMaps, so they are safe to run in parallel with other e2e tests.

roycaihw · 2026-03-10T22:05:37Z

kubernetes/informer/informer.py

+            kw["field_selector"] = self._field_selector
+        return kw
+
+    def _fire(self, event_type, obj):


Please document what fire means (execute handler callbacks)

roycaihw · 2026-03-10T22:18:43Z

kubernetes/informer/informer.py

+                        self._fire(BOOKMARK, event.get("raw_object", obj))
+                    elif evt_type == ERROR:
+                        self._fire(ERROR, obj)
+                    # Periodic resync: full re-list from the API server, firing


This periodic resync is placed after a watch event. Does it mean that the resync won't be triggered, even if the time passes, if there is no new watch event for a while?

roycaihw · 2026-03-10T22:21:26Z

kubernetes/test/test_informer.py

+            t.start()
+        for t in threads:
+            t.join()
+        self.assertEqual(errors, [])


Also verify the content in the cache?

roycaihw · 2026-03-10T22:39:43Z

kubernetes/test/test_informer.py

+
+        modified = []
+        informer = SharedInformer(list_func=list_func)
+        informer.add_event_handler(MODIFIED, modified.append)


Shall we also confirm that no other handler (CREATED, etc.) was fired?

roycaihw · 2026-03-10T22:46:05Z

kubernetes/e2e_test/test_informer.py

+        self.addCleanup(inf.stop)
+
+        self._wait_in_cache(inf, "default/" + name)
+        self.assertEqual(_name_of(inf.cache.get_by_key("default/" + name)), name)


Other than the name, shall we also verify the data of the stored configmap, to ensure the cache was correctly populated?

roycaihw · 2026-03-10T22:47:23Z

kubernetes/e2e_test/test_informer.py

+            name=name, namespace="default", body={"data": {"k": "updated"}}
+        )
+        self._expect(seen, "MODIFIED/" + name)
+        self.assertIsNotNone(inf.cache.get_by_key("default/" + name))


Shall we also confirm the updated data for this modified configmap?

roycaihw · 2026-03-10T22:53:58Z

This is awesome. Thanks!

Should I tag the bot when I leave comments for it to react? Also I wonder if it supports squashing commits to clean up at some point.

brendandburns · 2026-03-11T16:32:21Z

@copilot please address code review comments.

brendandburns · 2026-03-11T16:33:14Z

@roycaihw Thanks for the review. I believe that Prow automatically squashes the commits when it merges?

…ertions, e2e data checks Co-authored-by: brendandburns <5751682+brendandburns@users.noreply.github.com>

brendandburns · 2026-03-12T03:01:31Z

@roycaihw I think that all your comments were addressed, can you recheck?

brendandburns · 2026-03-12T19:47:35Z

@copilot please re-add the release note block to the description of this PR.

Copilot · 2026-03-12T19:48:51Z

@copilot please re-add the release note block to the description of this PR.

Done — the release-note block has been re-added to the PR description.

brendandburns · 2026-03-16T20:31:45Z

@copilot I don't think that you updated the PR description correctly, please have a look at the instructions here:

https://github.com/kubernetes/community/blob/master/contributors/guide/release-notes.md

You need something like:

some release note here

Copilot · 2026-03-16T20:33:00Z

@copilot I don't think that you updated the PR description correctly, please have a look at the instructions here:

https://github.com/kubernetes/community/blob/master/contributors...

The PR description has been updated with a properly formatted standalone release-note block at the end.

yliaog · 2026-03-17T19:59:29Z

@copilot i don't think the release note has been updated properly, could you double check?

yliaog · 2026-03-17T20:02:23Z

examples/informer_example.py

@@ -0,0 +1,75 @@
+# Copyright 2024 The Kubernetes Authors.


s/2024/2026/, please update all files

richabanker · 2026-03-17T21:25:58Z

kubernetes/informer/__init__.py

@@ -0,0 +1,27 @@
+# Copyright 2024 The Kubernetes Authors.


Nit: wrong copyright year? Does it matter?

roycaihw · 2026-03-17T23:11:06Z

kubernetes/informer/informer.py

                    self._resource_version = self._watch.resource_version
                self._watch = None
+
+            # Periodic resync: after the watch stream exits (whether due to the


This resync logic is now put after the

try: for event in self._watch.stream(self._list_func, **kw):

block, which seems weird to me. Does that mean resync won't be triggered as long as the watch stream doesn't end? How does resync work in client-go? @brendandburns @copilot

So the approach that is taken is that a server side timeout is added to the watch:

https://github.com/kubernetes-client/python/pull/2515/changes#diff-93fad1cf96b842fb065fa5599ff459088abee77bcb53d7103d31122ad73c9182R263

I don't think I have strong feelings one way or the other about interrupting on the server side or interrupting on the client side.

brendandburns · 2026-03-18T14:59:37Z

@copilot please address comments related to the copyright year, for newly created files, it should be updated to 2026 (the current year) instead of 2024. For existing files, the older copyright year should be retained. Do not change the copyright year for existing files, only new ones.

Please also add an e2e test for informer resync if it does not already exist.

Co-authored-by: brendandburns <5751682+brendandburns@users.noreply.github.com>

Copilot · 2026-03-18T15:03:35Z

@copilot i don't think the release note has been updated properly, could you double check?

The PR description has been updated in 1d10150 with a properly-formatted standalone release-note code block.

@copilot please address comments related to the copyright year, for newly created files, it should be updated to 2026 (the current year) instead of 2024. For existing files, the old...

Done in 1d10150. Copyright year updated to 2026 in all 6 new files (existing files untouched). Added test_resync_fires_modified_for_existing_objects to kubernetes/e2e_test/test_informer.py: starts the informer with resync_period=5, waits for the initial ADDED event, then waits up to 15 s for a MODIFIED event fired by the resync, and verifies the cached object's data is still correct.

Initial plan

ab86645

Copilot AI assigned Copilot and brendandburns Feb 20, 2026

Copilot started work on behalf of brendandburns February 20, 2026 18:34 View session

Add informer implementation: SharedInformer, ObjectCache, tests, and …

ef3f21c

…example Co-authored-by: brendandburns <5751682+brendandburns@users.noreply.github.com>

k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Feb 20, 2026

Copilot AI changed the title ~~[WIP] Add informer implementation to python-client~~ Add SharedInformer implementation to python-client Feb 20, 2026

Copilot AI requested a review from brendandburns February 20, 2026 18:42

Copilot finished work on behalf of brendandburns February 20, 2026 18:42

Copilot started work on behalf of brendandburns February 20, 2026 18:50 View session

Add BOOKMARK event support to SharedInformer

9c708ad

Co-authored-by: brendandburns <5751682+brendandburns@users.noreply.github.com>

Copilot finished work on behalf of brendandburns February 20, 2026 18:53

Copilot started work on behalf of brendandburns February 20, 2026 18:56 View session

Track and reuse resourceVersion across watch reconnects; re-list only…

d21aa1b

… on 410 Gone Co-authored-by: brendandburns <5751682+brendandburns@users.noreply.github.com>

Copilot finished work on behalf of brendandburns February 20, 2026 19:00

Copilot started work on behalf of brendandburns February 21, 2026 02:36 View session

Add e2e tests for SharedInformer against a real cluster

63bd3d5

Co-authored-by: brendandburns <5751682+brendandburns@users.noreply.github.com>

roycaihw reviewed Mar 10, 2026

View reviewed changes

Copilot stopped work on behalf of brendandburns due to an error March 11, 2026 16:32
Before you can use Copilot coding agent, you need to pick a "Usage billed to" option in your Copilot settings. Update your settings at https://github.com/settings/copilot/features, then try again.

Copilot started work on behalf of brendandburns March 11, 2026 16:35 View session

k8s-ci-robot added do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. and removed release-note Denotes a PR that will be considered when it comes time to generate release notes. labels Mar 11, 2026

Address 6 code review comments: _fire docstring, resync fix, test ass…

6e39732

…ertions, e2e data checks Co-authored-by: brendandburns <5751682+brendandburns@users.noreply.github.com>

Copilot finished work on behalf of brendandburns March 11, 2026 16:44

Copilot started work on behalf of brendandburns March 12, 2026 19:47 View session

Copilot finished work on behalf of brendandburns March 12, 2026 19:49

Copilot started work on behalf of brendandburns March 16, 2026 20:32 View session

Copilot finished work on behalf of brendandburns March 16, 2026 20:33

yliaog reviewed Mar 17, 2026

View reviewed changes

richabanker reviewed Mar 17, 2026

View reviewed changes

roycaihw reviewed Mar 17, 2026

View reviewed changes

Copilot started work on behalf of brendandburns March 18, 2026 15:00 View session

Fix copyright year to 2026 in new files; add e2e resync test

1d10150

Co-authored-by: brendandburns <5751682+brendandburns@users.noreply.github.com>

k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Mar 18, 2026

Copilot finished work on behalf of brendandburns March 18, 2026 15:04

Conversation

Copilot AI commented Feb 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

New package: kubernetes.informer

Testing

Uh oh!

k8s-ci-robot commented Feb 20, 2026

Uh oh!

brendandburns commented Feb 20, 2026

Uh oh!

Copilot AI commented Feb 20, 2026

Uh oh!

brendandburns commented Feb 20, 2026

Uh oh!

Copilot AI commented Feb 20, 2026

Uh oh!

brendandburns commented Feb 21, 2026

Uh oh!

Copilot AI commented Feb 21, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

roycaihw commented Mar 10, 2026

Uh oh!

brendandburns commented Mar 11, 2026

Uh oh!

brendandburns commented Mar 11, 2026

Uh oh!

brendandburns commented Mar 12, 2026

Uh oh!

brendandburns commented Mar 12, 2026

Uh oh!

Copilot AI commented Mar 12, 2026

Uh oh!

brendandburns commented Mar 16, 2026

Uh oh!

Copilot AI commented Mar 16, 2026

Uh oh!

yliaog commented Mar 17, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 18, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

brendandburns commented Mar 18, 2026

Uh oh!

Copilot AI commented Mar 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Copilot AI commented Feb 20, 2026 •

edited

Loading

New package: `kubernetes.informer`

Copilot AI commented Mar 18, 2026 •

edited

Loading